************

INTRODUCTION

************


This file describes how to set up and use the Ruby wrapper code for Melissa DATA's Address Object.


*************

PREREQUISITES

*************



To make use of the Address Object Ruby wrapper you will need:



* An installation of Ruby. This Wrapper was tested with Ruby 1.8.6.



* The Melissa DATA Address Object library and data files installed.

  These files are installed automatically if you run setup.exe. By default, the Address Object 

  Library (mdAddr.dll) is installed in:

	C:\Program Files\Melissa DATA\DQT\AddrObj\dll_32bit

* 64bit version available in C:\Program Files\Melissa DATA\DQT\AddrObj\dll_64bit

  and the Address Object data files in:

	C:\Program Files\Melissa DATA\DQT\Data



You will need to know the location of these items in order to install and run the Ruby wrapper.


**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.



***********

Demo Mode

***********



Please contact your sales representative to unlock Address Object. In Demo mode, Address Object will

only validate addresses in Nevada. Please call 1-800-MELISSA ext. 3 for more information.





*************

Installation

*************



Copy the entire folder that contains this readme.txt into a local directory on your computer.





*****

Setup

*****



You will need to allow mdAddrRubyWrapper.dll to find mdAddr.dll. You can do this by:



	1. Adding the directory containing mdAddr to your PATH environment variable. 

	   ex: set PATH=%PATH%;C:\Program Files\Melissa DATA\COM Objects\AddrObj\dll_32bit

* 64bit version available in C:\Program Files\Melissa DATA\DQT\AddrObj\dll_64bit



	or



	2. Copy mdAddr.dll into the directory with mdAddrRubyWrapper.dll.







**************************

Setting up the Sample Code

**************************



Open mdAddrTest.rb for editing. You must set the a license string that you receive from your Melissa Data sales representative and the path to the mdAddr data files.



License = "demo"

DataPath = "C:\\Program Files\\Melissa DATA\\DQT\\Data"



***********************

Running the Sample Code

***********************



Navigate to the directory containing the Ruby wrapper using command line and type:

	ruby mdAddrSample.rb





*******

Updates

*******



The files generated/included in this wrapper do not need to be changed for DQ Suite updates unless there is a method signature change in the object. If a new method is added, you will need to rebuild the wrapper to use the new method. 



****

Note

****



Here are some general solutions if you run into problems:



Q. I get an error saying "can't find mdAddr.dll." or "Entry Point not found."

A. This means that mdAddrRubyWrapper.dll cannot link to mdAddr.dll. Please follow the steps in

the Setup section above.







COPYRIGHT NOTICE



(C) 2014 Melissa Data Corporation. All rights reserved.

